home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / HTML / Menu / Renderer.php < prev    next >
PHP Script  |  2004-03-24  |  3KB  |  101 lines
  1. <?php
  2. //
  3. // +----------------------------------------------------------------------+
  4. // | PHP Version 4                                                        |
  5. // +----------------------------------------------------------------------+
  6. // | Copyright (c) 1997-2003 The PHP Group                                |
  7. // +----------------------------------------------------------------------+
  8. // | This source file is subject to version 2.0 of the PHP license,       |
  9. // | that is bundled with this package in the file LICENSE, and is        |
  10. // | available at through the world-wide-web at                           |
  11. // | http://www.php.net/license/2_02.txt.                                 |
  12. // | If you did not receive a copy of the PHP license and are unable to   |
  13. // | obtain it through the world-wide-web, please send a note to          |
  14. // | license@php.net so we can mail you a copy immediately.               |
  15. // +----------------------------------------------------------------------+
  16. // | Author: Alexey Borzov <avb@php.net>                                  |
  17. // +----------------------------------------------------------------------+
  18. //
  19. // $Id: Renderer.php,v 1.4 2004/01/13 15:53:43 avb Exp $
  20. //
  21.  
  22. /**
  23.  * An abstract base class for HTML_Menu renderers
  24.  *
  25.  * @package  HTML_Menu
  26.  * @version  $Revision: 1.4 $
  27.  * @author   Alexey Borzov <avb@php.net>
  28.  * @abstract
  29.  */
  30. class HTML_Menu_Renderer
  31. {
  32.    /**
  33.     * Type of the menu being rendered
  34.     * @var string
  35.     */
  36.     var $_menuType;
  37.  
  38.    /**
  39.     * Sets the type of the menu being rendered.
  40.     *
  41.     * This method will throw an error if the renderer is not designed
  42.     * to render a specific menu type.
  43.     *
  44.     * @access public
  45.     * @param  string menu type
  46.     * @throws PEAR_Error
  47.     */
  48.     function setMenuType($menuType)
  49.     {
  50.         $this->_menuType = $menuType;
  51.     }
  52.  
  53.  
  54.    /**
  55.     * Finish the menu
  56.     *
  57.     * @access public
  58.     * @param  int    current depth in the tree structure
  59.     */
  60.     function finishMenu($level)
  61.     {
  62.     }
  63.  
  64.  
  65.    /**
  66.     * Finish the tree level (for types 'tree' and 'sitemap')
  67.     *  
  68.     * @access public
  69.     * @param  int    current depth in the tree structure
  70.     */
  71.     function finishLevel($level)
  72.     {
  73.     }
  74.  
  75.  
  76.    /**
  77.     * Finish the row in the menu
  78.     *
  79.     * @access public
  80.     * @param  int    current depth in the tree structure
  81.     */
  82.     function finishRow($level)
  83.     {
  84.     }
  85.  
  86.  
  87.    /**
  88.     * Renders the element of the menu
  89.     *
  90.     * @access public
  91.     * @param array   Element being rendered
  92.     * @param int     Current depth in the tree structure
  93.     * @param int     Type of the element (one of HTML_MENU_ENTRY_* constants)
  94.     */
  95.     function renderEntry($node, $level, $type)
  96.     {
  97.     }
  98. }
  99.  
  100. ?>
  101.